[CLD-6659] Add documentation for Cloud IP Filtering #6792
Conversation
source/manage/cloud-ip-filtering.rst
Outdated
| Understanding CIDR Notation: | ||
| ---------------------------- | ||
|
|
||
|
|
||
| CIDR (Classless Inter-Domain Routing) notation is used to specify a range of IP addresses. It consists of an IP address followed by a forward slash and a number indicating the network's prefix length. For example: | ||
|
|
||
| - `192.168.0.0/24` represents the IP range from `192.168.0.0` to `192.168.0.255`. | ||
| - The `/24` signifies that the first 24 bits are the network address, leaving 8 bits for host addresses. | ||
|
|
||
| For a more in-depth explanation of CIDR notation, refer to `this article </https://aws.amazon.com/what-is/cidr/>`__. |
There was a problem hiding this comment.
This feature is inherently technical in that it requires knowledge of CIDR notation. I tried to hit an even ground of explanation without rewriting wikipedia. Generally, if you don't know what CIDR notation is, you probably aren't the intended audience for this feature
There was a problem hiding this comment.
Very fair assumption to make. Mattermost product documentation focuses on Mattermost-centric details and points readers to external, third-party sources where appropriate. Nicely done.
|
Newest code from nickmisasi has been published to preview environment for Git SHA 6993fb7 |
nickmisasi
added
1: Dev Review
|
Link to the specific page I've added in the preview environment: http://mattermost-docs-preview-pulls.s3-website-us-east-1.amazonaws.com/6792/manage/cloud-ip-filtering.html |
|
Newest code from nickmisasi has been published to preview environment for Git SHA 6993fb7 |
3 similar comments
|
Newest code from nickmisasi has been published to preview environment for Git SHA 6993fb7 |
|
Newest code from nickmisasi has been published to preview environment for Git SHA 6993fb7 |
|
Newest code from nickmisasi has been published to preview environment for Git SHA 6993fb7 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA a60d77e |
1 similar comment
|
Newest code from cwarnermm has been published to preview environment for Git SHA a60d77e |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 9108976 |
cwarnermm
removed
the
preview-environment
|
@amyblais - This is a v9.3 documentation update that's ready for release. |
|
Newest code from cwarnermm has been published to preview environment for Git SHA a9bdf5d |
Thank you, I believe the IP Filtering feature itself is scheduled for v9.4. |
|
Superb update. |
cwarnermm
added
the
Do Not Merge/Awaiting Next Release
|
Newest code from nickmisasi has been published to preview environment for Git SHA a9bdf5d |
|
|
||
| IP filtering is a powerful security feature that allows system admins to control access to their workspace by defining approved IP ranges. Only users within these specified IP ranges can access the workspace, ensuring enhanced security for your workspace. IP filtering requires a subscription to Mattermost Cloud Enterprise. | ||
|
|
||
| Configure IP filtering |
There was a problem hiding this comment.
@nickmisasi - Based on the v9.4 server changelog, Cloud IP Filtering will be disabled OOTB behind a feature flag.
Are you open to updating this new docs page to include details on enabling the feature flag as an admin?
There was a problem hiding this comment.
End users (ie, anyone not on the Mattermost Cloud team) can't control feature flags in Cloud. The feature flag's in place so that we can wait until other system dependencies (CWS, Provisioner, etc) are ready without having to hold up the 9.4 release. An additional benefit is that we can disable the new feature in the event a glaring issue is found after release.
I'm not sure it's worth documenting this as it's invisible to the user and may just cause confusion. Let me know what you think!
There was a problem hiding this comment.
One thing to add - the plan would be to enable the feature flag immediately as soon as the release rolls out to the enterprise ring in Cloud
There was a problem hiding this comment.
You're absolutely right -- users can't enable feature flags in Cloud. I'd forgotten that important point. No sense documenting something that Cloud admins won't be able to do.
Given that the plan is to enable soon after release to the Enterprise ring, I wonder if the changelog needs a small update to clarify that point? Thoughts?
|
Newest code from cwarnermm has been published to preview environment for Git SHA 2213b41 |
|
Newest code from stafot has been published to preview environment for Git SHA aff94e4 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 5f2ea81 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 3e49ef1 |
amyblais
removed
the
Do Not Merge/Awaiting Next Release
|
Newest code from amyblais has been published to preview environment for Git SHA 8cb2b1d |
Summary
Adds documentation for Cloud IP Filtering
See designs for more information: https://www.figma.com/file/BWimEkn5u8lgTPYt4b3GZn/MM-54295-IP-Filtering-Feature?type=design&node-id=1101-18721&mode=design&t=WqGsMcrjdXhwwnbn-4
Ticket Link
https://mattermost.atlassian.net/browse/CLD-6659